/*******************************************************************************
 *  * Copyright 2015 Impetus Infotech.
 *  *
 *  * Licensed under the Apache License, Version 2.0 (the "License");
 *  * you may not use this file except in compliance with the License.
 *  * You may obtain a copy of the License at
 *  *
 *  *      http://www.apache.org/licenses/LICENSE-2.0
 *  *
 *  * Unless required by applicable law or agreed to in writing, software
 *  * distributed under the License is distributed on an "AS IS" BASIS,
 *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  * See the License for the specific language governing permissions and
 *  * limitations under the License.
 ******************************************************************************/
package com.impetus.spark.client;

import java.util.List;
import java.util.Map;

import org.apache.spark.sql.DataFrame;

import com.impetus.kundera.metadata.model.EntityMetadata;

/**
 * The Interface DataClient.
 * 
 * @author: karthikp.manchala
 */
public interface SparkDataClient
{

    /**
     * Register table.
     * 
     * @param m
     *            the m
     * @param sparkClient
     *            the spark client
     */
    void registerTable(EntityMetadata m, SparkClient sparkClient);

    /**
     * Persist.
     * 
     * @param listEntity
     *            the list entity
     * @param m
     *            the m
     * @param sparkClient
     *            the spark client
     * @return true, if successful
     */
    boolean persist(List listEntity, EntityMetadata m, SparkClient sparkClient);

    /**
     * Save data frame.
     * 
     * @param dataFrame
     *            the data frame
     * @param entityClazz
     *            the entity clazz
     * @param properties
     *            the properties
     */
    void saveDataFrame(DataFrame dataFrame, Class<?> entityClazz, Map<String, Object> properties);

}
